Shareware Grab Bag/Shareware Grab Bag.iso/015/ctdeskv2.arc/CITYDESK.DOC

Text File | 1987-03-01 | 21KB | 429 lines

~                   ~BU\CITYDESK DOCUMENTATION|

.b\    CITYDESK.EXE ver2.0 Copyright (c) 1987 Robert S. Shaw


                          OVERVIEW

   CITYDESK.EXE  is  a printer utility program for  printing
enhanced  files  with  dot  matrix  printers.  Certain
requirements  of the program must be met for the printer  to
operate  properly.  One requirement is that the printer must
allow  88  lines of print per page (most do  although  some
letter  quality  printers  wont.)  The  second  important
requirement is that the printer will support at least 17 CPI
pitch  so  that  136  columns across can be  printed.  Most
printers also do this,  but please check your printer manual
before proceeding.

   CITYDESK  is a shareware approach to desk top  publishing
in  a  simplified way.  It allows one to prepare text  files
with word processors which produce clean ASCII files such as
PC-WRITE (c)  or with most word processors which can save  a
file  in  document  form.  These  files  may  contain  extra
commands  which  will  generate bold typeface such  as  this
paragraph,  underlining as with the title,  and Italic  type
face.  Combinations are also available up to and  including
.bui\bold underlined italic.

   Other  commands  are  available  for  in-line  emphasis,
paragraph emphasis and extended ASCII graphics. The commands
may be used to add pizzzaz!  to your printed document at any
location,  by single line,  by single word or phrase or  by
paragraph or group of lines.  Most other printer enhancement
utilities do not give such flexibility of control with  such
simple commands.

               ==============================

    Dot  (.)  commands  are used by  placing  them  at  the
beginning  of any line.  Each dot command must begin with  a
dot (.) or period on the keyboard. Each dot command must end
with  the  backslash [\] at the left of the  keyboard.  For
example  [.bui\] will be executed for the next few lines  to
.bui\illustrate  the use of bold underlined italic printing.  By
.bui\the  same method using just the command [.bi\] the following
.bi\line  will  be in just bold italic.  Do not incorporate  the
left  and  right  braces  [used here  for  offset]  in  your
commands.  Dot commands function on one line only.  (In  the
above  illustration  the italicized part will not show  with
IBM PROPRINTER because italic is not allowed.)

    Tilde  commands  may  be used within a  single  line  to
create  emphasis  with a single word or one  phrase.  Tilde
commands are used in a similar way to dot (.) commands. Only
now you must alert CITYDESK to the fact that an in line type
change  is  expected  by placing a Tilde   in  the  zero-th.
position  of the line.  Then immediately before the word  or
phrase  to  be  emphasized  you  will  place  another  Tilde
followed by the B U or I emphasis desired or any combination
of them and close the command with the backslash (\) key. To
mark the end of emphasis you will place the Broken  vertical
bar  symbol|  at the end of the phrase.  If  the  emphasized
phrase  ends  at the end of a line the broken  vertical  bar
must still be added.  In the context used here the  zero-th.
position  means  the  first character of a line  or  at  the
beginning.

Note:  Tilde commands may only be used once in a line!  And
may not be used in conjunction with the dot (.) command.


!B\
    Bang  (!)  aka  exclamation  mark  commands  are  also
available  for  entering several lines or paragraphs  in  an
emphasized mode without having to enter a dot (.) command at
the beginning of each line. This particular paragraph of the
document  was  prefaced with the !B\ command entered on  the
previous  line.  Bang commands must stand alone on a  line.
They only take room on the editing screen and do not cause a
line  feed when printing.  The BANG command as well  as  the
cntrl  (^)  command which closes the BANG must be the  first
character of the line or in the zero-th. position.  The BANG
command  may  be followed by B U or I or any combination  of
the  three and is closed with the backslash (\).  The  cntrl
(^)  close  command stands alone with no  other  characters
following at the zero-th.  position.  Optionally the dot (.)
command may be used while the BANG command is in effect. The
tilde  command may also be used in conjunction with the bang
command.
^

~                          ~BU\Centering|

   Underline  centering  can  be created in the  normal  way
provided  the  Tilde  command is  located  at  the  zero-th.
position of a line.  A good method to follow is to type in a
line,  use  the word processors functions to center it  and
then work from the right to the left. First place the (|) at
the end of emphasis.  Then move left to the beginning of the
desired  phrase  and  insert a tilde  command  [~bui\]  then
moving to the zero-th. position and insert the first tilde.

Example: ~this will cause     ~bui\emphasis|
~this will cause           ~BUI\emphasis|

If  underlining  was on with the dot command the whole  left
portion  of  the line would also be  underlined.  Centering
without  underlining  can be emphasized with  the  (.)  dot
command.

              ********************************
              *                              *
              *     Fancy Show Off Stuff     *
              *                              *
              ********************************

               With a little bit of practice!!
           You will be creating subtitle banners.

CITYDESK NEWS LINE    ___             CREATE A NEWSLETTER
                     /   \
    The World's     /|oo  \
  1st Network for  (_|  /__)               FOR YOUR
    the IBM PC      _`@/_  \   _
                   |     |  \  \\
                   | (@) |   \  ))           OWN
     ______        |__0__| /  \//
    / FIDO \       _// || _\   /        COMMUNICATIONS
   (________)     (_/ (_|(____/

   Operating  24 HRS A DAY.         BULLETIN BOARD AND BBS
              7 DAYS A WEEK


~                     ~U\USING CITYDESK.EXE|


     The  first  step  in preparing to use  CITYDESK  is  of
course to decide what ASCII text file is to be printed.  Two
approaches here are available. One, create your own document
by  typing  it into a word processor.  Two,  use an  already
available  text file which you have obtained previously.  In
the  first  case it is best to just type your  file  without
incorporating the dot or tilde commands. When you do this be
sure  to set your right margin at 60  so that you  will  not
have to reformat in the next step.  Also it would be a  good
idea  to  proof read your file now so that incorporation  of
the (.) (~) and (!) commands are all that is required in the
second step.  In the second step or as in the second case of
a  previously  obtained file,  you will insert the  dot  and
tilde  commands  in the manner illustrated by this  document
(print  it without using CITYDESK.)  As you incorporate  the
commands the lines of text should push to the right and many
will extend beyond the original 60 column right margin. This
is fine since the commands only take up room on your editing
screen  and  not  on  the printed page;  they  are  in  fact
embedded  escape  codes for the printer.  Do not fret  about
line length when incorporating commands.  If you are using a
previously  generated file and its format is greater than 60
column line length,  you must first reformat to 60  columns.
Most word processors have this ability built right into them
and  it usually is just a matter of pressing a few  function
keys  to  mark the document and then squeeze  left.  Please
consult your word processor's manual for how to perform  the
reformatting process.


    Using  an Epson(tm)  or compatible printer  select  menu
item #1. If you use an IBM PRO-PRINTER(tm) you should select
item  #2.  This selection also provides a special  feature.
While  it removes the possibility of italic  enhancement  it
provides  continuous access to EXTENDED ASCII GRAPHICS.  If
you use another printer (Okidata excepted) which doesn't use
Epson  or  IBM PROPRINTER escape codes you  may  select  the
CUSTOM MODE or menu item 3.  This will allow you to create a
printer  definition file named CITYDESK.DEF.  Once this file
is  in your disk directory,  every time thereafter when  you
make  this selection CITYDESK will read the definition  file
and  you will not have to reenter the information.  If  you
change  printers and need to create a new printer definition
file just delete CITYDESK.DEF from the directory.


     CITYDESK.EXE should be located in a subdirectory  (hard
disk) which is named in the default path specification or it
may be called from a floppy drive by A:CITYDESK.  The output
of  the  program may be redirected by menu option to a  disk
file.  The  file  which will be written in the  default  or
current  directory should be assigned a name different  from
the  original text file to avoid overwriting  the  original.
The  usefulness of this is that the newly created file  will
contain  all the printer escape codes and will be in the two
column format of CITYDESK and can then be reprinted without
going through the CITYDESK setup simply by using the C: copy
myfile.txt prn command from DOS.


     CITYDESK.EXE will first ask you to specify what type of
printer you are using.  It will then request the name of the
text  file  which  you have prepared with the (.  ~  !  )
commands. Next you will be asked if you want to print to the
printer  or to a disk file.  If you specify a disk file  you
will  have to supply a name for the file.  Use a name  which
conforms  to  conventional  DOS  specifications  (eight
characters,  a  dot  or  period  and  a  three  character
extension.)  It  will then ask if you would like to have  a
single  banner line (centered)  across the top of the  first
page.  If yes, you will be asked to enter the text. You will
be allowed 36 characters for your banner and then the option
to  have the text in normal or italic print style.  You  may
select  a decorative key such as * or # or the tilde (~)  to
make a box around the banner or press return for no box just
a single line of text in double width emphasized print.  If
you  are using the IBM PROPRINTER mode you may elect to  use
an  EXTENDED ASCII code symbol for the decorative character.
The  banner will be redrawn to give a rough illustration  of
what it will look like on the printed page. If you have made
an error or would like to 'redo' the banner simply press the
'R' key and repeat the entry. Once you accept the banner the
printer will immediately execute the banner line.  You  will
then be given the option of numbering the pages (centered at
the  bottom.) One final option is  to  print the entire file
in double strike or  the equivalent  of  !B\. The reason for
this is to conserve line length usage  if you want extra
dark printing for the whole document (see explanation of use
of  columns  under  IBM  PROPRINTER  section; bold or double
uses 8 col.)  On the right hand side of the screen you will
see  cumulative report of all the choices you have  made  to
keep track of OPTIONS.  A very brief pause will follow while
the program reads the beginning of the document file.  After
printing  begins  it's  best  to let  "sleeping  dogs  lie."
Continuous printing of all the pages will follow.  This will
be recorded and reported under the STATUS block at the right
of  the screen.  When the computer has sent the last of  the
information to the printer,  the warning message flashing in
bright  white  will appear.  This is to caution you  not  to
commence  another project until the printer buffer is  empty
and printing ceases.



~                      ~BU\TROUBLE SHOOTING|


    If  the message no resume in XXXX appears it most likely
means the printer is not available.  Compiled basic programs
just  die when an I/O is attempted to a device which is  not
online.  Remedy  is  check and bring  printer  online  then
restart  CITYDESK.EXE  Another cause of this error  is  line
length  of a line greater than 60  characters long  although
this  error is usually trapped and reported.  Sometimes  in
editing  a  line  an extended length which  is  not  readily
visible  on  the  screen may be actually  present  as  blank
spaces.  One method to check for this is,  using your  word
processor, place the cursor at the end of the line using the
"End" key on the key pad. If it scoots past the end and over
60  then you have added blank spaces on the end of the line.
Remedy  is reposition cursor at end of line and hit  return.
You  may then have to delete a blank line or do  some  other
minor editing. Extra blank spaces or lines too long can also
result in a printout with blank space where not expected and
a  cross  over  of the last part of a line  from  the  right
column into the left column.  Of course this would be a clue
as  to  which line in the left column had  the  extra  blank
spaces tacked on to it.

    If  CITYDESK  just seems to die and go nowhere the  most
likely  cause  of  this problem is that a  command  was  not
closed. The backslash (\) on a dot (.) or tilde (~)  command
was omitted or the final broken bar (|) was not completed.

    CITYDESK  will  almost certainly die if you  attempt  to
direct  the  output through a print  spooler  utility.  The
reason  for this is the program is in compiled  basic.  The
obvious  way to avoid tying up time on the printer is to use
the print to disk option when setting up. The disk file will
be  prepared  very quickly and then you may  exit  CITYDESK,
install the print spooler (without pagination) and print the
enhanced file.


DOT COMMAND SUMMARY

 .B\ produces the line which follows with bold type.
 .U\ produces the line which follows with underlining.
 .I\ produces the line which follows with Italic type.

The  commands may be concatenated up to all  three  provided
the command begins with a dot (.)  and ends with a backslash
"\". Example: .BIU\ Both upper and lower case are honored so
the .ubi\ will create the same result.


TILDE COMMAND SUMMARY

Begin each line with a Tilde (~)  Immediately before a  word
or  phrase enter another tilde Followed by the choice of B U
or I or all three.  Close the tilde command with a Backslash
(\).  Mark  the  end of emphasis with  a  Broken  Bar  (|).
Example:  ~The quick ~bu\brown fox| jumped over the  fence.
Will produce:
~       The quick ~BU\brown fox| jumped over the fence.

Note: Tilde commands may not be used in conjunction with dot
commands,  but  may be used while the BANG (!)  command  is
operating.


BANG COMMAND SUMMARY

The  BANG  (!)  command is a general usage  command  which
allows  for turning on of any or all of the BOLD,  UNDERLINE
OR  ITALIC attributes.  Both dot commands and tilde commands
may  be  entered while the BANG is operating.  The  Bang  is
started  with the (!)  entered as the first character  on  a
line  and followed by any or all of the B U I characters and
closed  with  the  backslash  (\).  The BANG  is  ended  by
entering the cntrl (^) character on a single line alone.  If
you wish extra dark printing of your document then you could
turn on the BANG (!)  with !B\on the first line and close it
with  the cntrl(^)  on  the last line.  However, this method
would be very  costly  in  line  length  usage. An option is
provided to make the whole document DARK. Choose this method
from the options offered just following numbering of pages.

!B\

                   EXTENDED ASCII GRAPHICS

    This  section was saved for the end because it has  some
important implications. With Epson compatible printers it is
possible  to download the extended ASCII graphics  (176-223)
and  use  them  as  printable  characters  allowing  for
interesting BLOCK graphic picture presentation. However, you
have  to  give  a little to get a little.  If  you  turn  on
extended  ASCII graphics you must give up the use of  ITALIC
emphasis while in the graphic mode. (I don't think this is a
very  big  deal  because the italic  print  isn't  all  that
great.)  The italic printable codes occupy concurrent RAM in
the  printer  with  the extended graphics.  Thus  if  italic
emphasis  is called with the dot(.)  tilde (~)  or BANG  (!)
commands  some graphic characters may print instead  of  the
normal  italicized letter.  Please consult a table of  ASCII
character symbols (usually in an appendix of a BASIC manual)
to  assist in preparation of block graphics.  These  may  be
entered  in most word processors by holding down the Alt key
and press in the three digit code and then releasing the Alt
key.  With  Epson compatible printers you  can  switch  the
graphics  mode off and return to use of ITALIC by entering a
$ by itself as the first and only character on a line. As in
all  single  character  command  entries it  only  takes  up
editing space and does not cause a line feed. (This actually
cause a reset of the printer on the fly.)
    This  feature is not implemented in this release  of
CITYDESK but may be ordered by contacting the author.
^


~                       ~BU\IBM PROPRINTER|

    Just  as  the Epson EXTENDED GRAPHIC mode forces  us  to
give up Italic printing,  the IBM PROPRINTER mode forces  us
to  give up italic printing.  With this mode extended  ASCII
graphics are always available, but no italics.

    Owners  of  wide  carriage  printers may  also  order  a
version  of  CITYDESK  which allows for two  columns  of  80
characters each per page.  On this subject the limitation of
2  60 char. columns should be explained. 80  column printers
in  condensed mode will only allow 136  characters per  line
whether  the string ($)  being printed contains escape codes
or not.  Thus escape codes are not really transparent to the
printer  but add in and count in legal string length.  With
this  in  mind and the need to allow some  leeway  for  text
enhancement,  we have allowed 2X60  columns =120  characters
plus  2  columns spacing for clarity =  122  columns.  The
minimum for 1 column with bold, underline & italic requires
14  characters to satisfy the enhancement. Hence 122 + 14 =
136  and we have used up all the string space  the  printer
will allow.


~                ~BU\FILES WITH FORM FEED INCLUDED|


    FORM FEED or CHR$(12)  if located alone in the  zero-th.
position of a line will be ignored by CITYDESK, tracking its
own  pagination.  This is the location most authors use  to
force  a new page on the printer.  However,  some times  the
CHR$(12) may occur at the end or middle of a line. This will
definitely confuse CITYDESK and cause trouble.  Please  scan
the document for this symbol and the best procedure would be
to remove it with a search and replace function in your word
processor.

!B\
Robert S. Shaw 3696 Marquis Lane Huntingdon Valley, Pa.
19006

You are hereby granted a limited license to use this program
for a trial period. If you continue to use the program more
than five (5) times, you are requested to send the author
$25.

In return for your monetary support the author will send you
the CITYEDITOR'S DESK a nifty utility for fast editing and
incorporating of the dot tilde and all enhancement commands.
The function keys are used to enter your selection.

Copyright 1986 1987  RSHAW

I would like to acknowlege the help of the following:

The Amazing and Wonderful BASWIND2 material by Dave Evers
which added such beauty and simplicity to my efforts.

My good friend Ron Craig who has suffered through too many
phone calls requesting a quick print-out.

A most welcome new friend Stew Lindenberger of Bell Labs who
was the prime inspiration to get this baby rolling and who
helped greatly with the IBM PROPRINTER section.

And Tom Lynch who out of the blue called and proved that it
will work just fine on Tandy computers. But we all knew that
anyway.

Thanks guys you have all been great help and inspiration!!!!